<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilloader: XilLoader Versal APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilloader
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xloader__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">XilLoader Versal APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gad42561569e2b33308b616325ca0c58dc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#gad42561569e2b33308b616325ca0c58dc">PDI_SRC</a>&#160;&#160;&#160;(<a class="el" href="xloader__plat__client_8h.html#af14fcbd99f3aaf94c6ecc1f3689b8485">XLOADER_PDI_SRC_DDR</a>)</td></tr>
<tr class="memdesc:gad42561569e2b33308b616325ca0c58dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">0xF - DDR, 0x10 - Image Store  <a href="#gad42561569e2b33308b616325ca0c58dc">More...</a><br/></td></tr>
<tr class="separator:gad42561569e2b33308b616325ca0c58dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55aa586df150c1192826a1c57dd87401"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#ga55aa586df150c1192826a1c57dd87401">DATA_ID</a>&#160;&#160;&#160;(0x21)</td></tr>
<tr class="memdesc:ga55aa586df150c1192826a1c57dd87401"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data ID of the optional data.  <a href="#ga55aa586df150c1192826a1c57dd87401">More...</a><br/></td></tr>
<tr class="separator:ga55aa586df150c1192826a1c57dd87401"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#ga50bc47889e36ccd506a9cdf1528b050b">PDI_SRC_ADDR</a>&#160;&#160;&#160;(0x1000000U)</td></tr>
<tr class="memdesc:ga50bc47889e36ccd506a9cdf1528b050b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address where PDI is available.  <a href="#ga50bc47889e36ccd506a9cdf1528b050b">More...</a><br/></td></tr>
<tr class="separator:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26c3bbc23f659d18e5ad594d43639efd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#ga26c3bbc23f659d18e5ad594d43639efd">PDI_ID</a>&#160;&#160;&#160;(0x3)</td></tr>
<tr class="memdesc:ga26c3bbc23f659d18e5ad594d43639efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">PDI ID of the PDI available in Image Store.  <a href="#ga26c3bbc23f659d18e5ad594d43639efd">More...</a><br/></td></tr>
<tr class="separator:ga26c3bbc23f659d18e5ad594d43639efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf68dddec126f79c069eb06e007c6c22"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#gabf68dddec126f79c069eb06e007c6c22">OPT_DATA_BUFFER_SIZE_IN_BYTES</a>&#160;&#160;&#160;(0x200U)</td></tr>
<tr class="memdesc:gabf68dddec126f79c069eb06e007c6c22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of optional data buffer.  <a href="#gabf68dddec126f79c069eb06e007c6c22">More...</a><br/></td></tr>
<tr class="separator:gabf68dddec126f79c069eb06e007c6c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacceb00140e2a0a8443cd8b268538e7f9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#gacceb00140e2a0a8443cd8b268538e7f9">XLOADER_ERR_INVALID_OPT_DATA_BUFF_SIZE</a>&#160;&#160;&#160;(0x25)</td></tr>
<tr class="memdesc:gacceb00140e2a0a8443cd8b268538e7f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error when buffer size given by user is less than the optional data length.  <a href="#gacceb00140e2a0a8443cd8b268538e7f9">More...</a><br/></td></tr>
<tr class="separator:gacceb00140e2a0a8443cd8b268538e7f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#ga50bc47889e36ccd506a9cdf1528b050b">PDI_SRC_ADDR</a>&#160;&#160;&#160;(0x1000000U)</td></tr>
<tr class="memdesc:ga50bc47889e36ccd506a9cdf1528b050b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address where authenticated PDI is available.  <a href="#ga50bc47889e36ccd506a9cdf1528b050b">More...</a><br/></td></tr>
<tr class="separator:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba48a7835dd58698e529a2fbfe1274f5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__apis.html#gaba48a7835dd58698e529a2fbfe1274f5">PDI_TYPE</a>&#160;&#160;&#160;(<a class="el" href="xloader__plat__client_8h.html#a1652b4d0eb7aed02ead9dc01a2308f01">XLOADER_PDI_TYPE_FULL</a>)</td></tr>
<tr class="memdesc:gaba48a7835dd58698e529a2fbfe1274f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">XLOADER_PDI_TYPE_FULL for full PDI XLOADER_PDI_TYPE_PARTIAL for partial PDI.  <a href="#gaba48a7835dd58698e529a2fbfe1274f5">More...</a><br/></td></tr>
<tr class="separator:gaba48a7835dd58698e529a2fbfe1274f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga55aa586df150c1192826a1c57dd87401"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DATA_ID&#160;&#160;&#160;(0x21)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data ID of the optional data. </p>

</div>
</div>
<a class="anchor" id="gabf68dddec126f79c069eb06e007c6c22"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define OPT_DATA_BUFFER_SIZE_IN_BYTES&#160;&#160;&#160;(0x200U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size of optional data buffer. </p>

</div>
</div>
<a class="anchor" id="ga26c3bbc23f659d18e5ad594d43639efd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_ID&#160;&#160;&#160;(0x3)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PDI ID of the PDI available in Image Store. </p>
<p>Mandatory option when PDI_SRC is selected as Image Store </p>

</div>
</div>
<a class="anchor" id="gad42561569e2b33308b616325ca0c58dc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_SRC&#160;&#160;&#160;(<a class="el" href="xloader__plat__client_8h.html#af14fcbd99f3aaf94c6ecc1f3689b8485">XLOADER_PDI_SRC_DDR</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>0xF - DDR, 0x10 - Image Store </p>

</div>
</div>
<a class="anchor" id="ga50bc47889e36ccd506a9cdf1528b050b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_SRC_ADDR&#160;&#160;&#160;(0x1000000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address where authenticated PDI is available. </p>

</div>
</div>
<a class="anchor" id="ga50bc47889e36ccd506a9cdf1528b050b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_SRC_ADDR&#160;&#160;&#160;(0x1000000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address where PDI is available. </p>
<p>Mandatory option when PDI_SRC is selected as DDR </p>

</div>
</div>
<a class="anchor" id="gaba48a7835dd58698e529a2fbfe1274f5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_TYPE&#160;&#160;&#160;(<a class="el" href="xloader__plat__client_8h.html#a1652b4d0eb7aed02ead9dc01a2308f01">XLOADER_PDI_TYPE_FULL</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>XLOADER_PDI_TYPE_FULL for full PDI XLOADER_PDI_TYPE_PARTIAL for partial PDI. </p>

</div>
</div>
<a class="anchor" id="gacceb00140e2a0a8443cd8b268538e7f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_ERR_INVALID_OPT_DATA_BUFF_SIZE&#160;&#160;&#160;(0x25)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Error when buffer size given by user is less than the optional data length. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
